How to access the database

You can access the deployment’s database in read‑only mode to develop add‑ons or build reports.

Before you begin

Install these tools on your workstation:

• AWS CLI

  Download and install here.

• AWS Session Manager Plugin

  Download and install here.

Enable database access

You must enable the feature on the deployment before connecting:

1. Open the deployment detail page in the X3 Cloud portal.

2. Open the Actions menu icon and select Database access.

   

3. Activate the Allow database access toggle.

   

Manage database users

Manage passwords

Fetch a current password

Use this function to display the current password for this account.

1. Select Partner or Customer.

2. Select Get password.

   

3. Copy and save the password.

Rotate a password

Use this function to ask for a new password for this account.

1. Select Partner or Customer.

2. Select Rotate password.

   

3. A confirmation window opens. Select Yes. 

4. The rotation will take a few minutes to come into effect. You can check the progress of the password rotation in the Operations tab.

Connect to the database

When you have the password, you can connect to the database:

1. In the Connect to database tab, select Get database access. The portal generates the terminal commands required to open the secure session.

   

   Note:

   The portal automatically selects Bash or PowerShell based on your operating system. Bash is used on Linux and macOS, while PowerShell is used on Windows.

2. Copy the commands.

3. Open a terminal and paste the commands you copied from the portal.

4. Run the commands to start the secure connection.

5. Open your SQL tool.

   

6. Configure your SQL tool with:

   1. Username

   2. Password

   3. Server

   4. Port

You are now connected to the database in read‑only mode.